HappyDoc Generated Documentation .\AddH

. / AddH 

Add hydrogens to structures

Functions   
  findRotamerNearest 
findRotamerNearest (
        atPos,
        idatmType,
        atom,
        neighbor,
        checkDist,
        )
  bondWithHLength 
bondWithHLength ( heavy,  idatmType )
  hbondAddHydrogens 
hbondAddHydrogens (
        models,
        unknownsInfo={},
        hisScheme=None,
        )

Add hydrogens to given models, trying to preserve H-bonding

Arguments are similar to simpleAddHydrogens() except that for histidines not in the hisScheme dictionary, the hydrogen-bond interactions determine the histidine protonation.

  determineNamingSchemas 
determineNamingSchemas ( molecule,  typeInfo )

Determine for each residue, method for naming hydrogens

The two possible schemas are: replace -- put H in place of element name prepend -- put H in front of entire atom name

In both cases, a number will be appended if more than one hydrogen is to be added.

Replace is the preferred scheme and is used when the heavy atoms have been given reasonably distinctive names. Prepend is used mostly in small molecules where the atoms have names such as C1, C2, C3, N1, N2, etc. and replace would not work.

  gatherUnknowns 
gatherUnknowns ( models,  prevUnknowns=[] )

Find atoms whose hydrogen-adding geometries are unknown

  cmdAddH 
cmdAddH (
        molecules=None,
        hbond=True,
        useHisName=True,
        )
  simpleAddHydrogens 
simpleAddHydrogens (
        models,
        unknownsInfo={},
        hisScheme=None,
        )

Add hydrogens to given models using simple geometric criteria

Geometric info for atoms whose IDATM types don't themselves provide sufficient information can be passed via the unknownsInfo dictionary. The keys are atoms and the values are dictionaries specifying the geometry and number of substituents (not only hydrogens) for the atom.

The hisScheme keyword determines how histidines are handled. If it is None then the residue name is expected to be HIE, HID, HIP, or HIS indicating the protonation state is epsilon, delta, both, or unspecified respectively. Otherwise the value is a dictionary: the keys are histidine residues and the values are HIE/HID/HIP/HIS indication of the protonation state. Histindines not in the dictionary will be protonated based on the nitrogens' atom types.

the protonation is determined by the nitrogen atom type.

This routine adds hydrogens immediately even if some atoms have unknown geometries. To allow the user to intervene to specify geometries, use the initiateAddHyd function of the unknownsGUI module of this package.

  roomiest 
roomiest (
        positions,
        attached,
        checkDist,
        )
  newHydrogen 
newHydrogen (
        parentAtom,
        Hnum,
        totalHydrogens,
        namingSchema,
        pos,
        )
  findNearest 
findNearest (
        pos,
        atom,
        exclude,
        checkDist,
        )
Classes   

IdatmTypeInfo

Python files   

ChimeraExtension.py

gui.py

hbond.py

prefs.py

simple.py

unknownsGUI.py

GUI to query user for hydrogen-addition info of non-IDATMed atoms

Subdirectories   

helpdir


This document was automatically generated Thu Nov 09 13:33:42 2006 by HappyDoc version 3.0.a1